feat: DH-21757: WidgetPlugin support in deephaven.ui by mofojed · Pull Request #1341 · deephaven/deephaven-plugins

mofojed · 2026-04-27T21:52:21Z

WidgetPlugin just registers directly
- Allows for nested ui.resolve deephaven.ui components
Still maintain DashboardPlugin to handle legacy behaviour
Works with the ui_home_screen, nested dashboards, etc
Styling a little bit different (ui.panel is automatically wrapped in a nested dashboard rather than opening up panels in the existing dashboard like before)
- Keeps all components contained to a panel, rather than mixing with other components in the same dashboard
Dashboard now has a show_headers option that can be set to False to not show headers on a dashboard. Useful if you're doing a homescreen type dashboard

- Needs deephaven/web-client-ui#2648 - WidgetPlugin just registers directly - Allows for nested ui.resolve deephaven.ui components - Still maintain DashboardPlugin to handle legacy behaviour - Works with the ui_home_screen, nested dashboards, etc - Styling a little bit different (ui.panel is automatically wrapped in a nested dashboard rather than opening up panels in the existing dashboard like before) - Dashboard now has a `show_headers` option that can be set to False to not show headers on a dashboard. Useful if you're doing a homescreen type dashboard

- Add moduleNameMapper in jest.config.cjs to resolve React 18 from the plugin's local node_modules, fixing dual-React-instance errors - Mock usePersistentState in @deephaven/plugin mock to avoid FiberProvider dependency in tests - Update DocumentHandler test to reflect new behavior where non-layout children are rendered directly without ReactPanel wrapping

…ader

- Wrap bare (non-layout) widget children in DefaultPanelContent so they receive padding and surface widget loading/error states (fixes the ui_boom_counter error overlay not appearing after the WidgetPlugin refactor). - Add a styles.scss rule that strips the outer ReactPanel padding when its only child is a .dh-nested-dashboard, eliminating the duplicate padding around nested dashboards (e.g. ui_deeply_nested_dashboard).

- There's an issue here - when the ui.dashboard is the othermost thing, it should just take over the outer dashboard. Right now it's embeddign in. Need to fix that.

When a deephaven.ui widget is a single ui.panel hosted by the core WidgetPanel (e.g. opened via the WidgetPlugin in a code studio or in the embed widget scenario), render the panel's children inline using DefaultPanelContent instead of opening another GoldenLayout panel. Previously this produced a panel tab nested inside another panel tab. DefaultPanelContent now forwards the same View/Flex props that ReactPanel accepts so the user's ui.panel styling (padding, direction, gap, etc.) is preserved when rendered inline, and applies the dh-react-panel/dh-inner-react-panel class names so existing CSS rules (grid/chart padding strip, etc.) still apply. Also scope the nested-dashboard padding rule to .dh-react-panel so the outer WidgetPanel does not add extra padding around a top-level ui.dashboard in the embed widget scenario.

github-actions · 2026-04-27T21:58:00Z

ui docs preview (Available for 14 days)

- Shouldn't need to update all of these, there are likely some other fixes I need to do.

github-actions · 2026-04-29T01:15:12Z

ui docs preview (Available for 14 days)

github-actions · 2026-04-29T02:14:35Z

ui docs preview (Available for 14 days)

- now we don't have padding on the dashboard in the embed widget app scenario

github-actions · 2026-04-29T02:54:28Z

ui docs preview (Available for 14 days)

github-actions · 2026-04-29T14:51:48Z

ui docs preview (Available for 14 days)

github-actions · 2026-05-06T19:05:23Z

ui docs preview (Available for 14 days)

margaretkennedy

Docs look good

dsmmcken

Are all the other e2e changes expected?

dsmmcken · 2026-05-08T17:56:32Z

+        "Value=i%2==0 ? `A` : `B`",
+        "Row=i",
+    ]
+)


You shouldn't use a timetable in e2e tests, you don't want anything ticking.

Though it doesn't look like the e2e tests display this, on screen. I think you should still switch it over so agents to follow it as a pattern.

Co-authored-by: Don <dsmmcken@gmail.com>

mofojed · 2026-05-11T14:22:21Z

Adding @dgodinez-dh as the primary reviewer as he'll have more cycles this week than @vbabich

github-actions · 2026-05-11T14:28:18Z

ui docs preview (Available for 14 days)

…creen

github-actions · 2026-05-11T14:53:19Z

ui docs preview (Available for 14 days)

mofojed · 2026-05-11T14:58:29Z

@dsmmcken related to the other e2e changes:

ui_embed_widget.spec.ts-snapshots: Multi-panel widget: Before, when opening multiple panels ad hoc from a @ui.component, e.g.:

@ui.component
def ui_multi_panel_component():
    return [
        ui.panel(ui.button("Hello"), title="foo"),
        ui.panel(ui.text("World"), title="bar"),
    ]

we'd open them as a stack. This was inconsistent with how they were when it was displayed within a dashboard, e.g.

d = ui.dashboard([
    ui.panel(ui.button("Hello"), title="foo"),
    ui.panel(ui.text("World"), title="bar"),
])

Now opening a multi-panel component opens it in a nested dashboard, and the behaviour is consistent.

ui_nested_dashboard.spec.ts-snapshots: Removed the Close button from panels in a nested dashboard. Panels are controlled programmatically, and closing one can result in odd behaviour; user can't bring it back, it may re-appear randomly if the panel re-renders in the dashboard. If they don't want to see it, it can be stacked behind other panels.
ui.spec.ts-snapshots: Looks like I'm including the panel tab in the screenshot. I don't need to do that, I can clean that up.

dgodinez-dh · 2026-05-11T15:44:26Z

  // We may need to check if we need to close this widget if all panels are closed
  const [isPanelsDirty, setPanelsDirty] = useState(false);

+  const id = useMemo(


It looks to me like this id is only used for debug logging? It might be more useful to add as much info to the id as is defined (e.g. id-name-type if it has all three).

dgodinez-dh · 2026-05-11T15:56:13Z

+  uri?: UriVariableDescriptor;
+};
+
+export function UIComponent(props: UIComponentProps): JSX.Element | null {


We should add a comment explaining UIComponent.

dgodinez-dh · 2026-05-11T15:57:13Z

+
+type UIWidgetProps = WidgetComponentProps<dh.Widget>;
+
+export function UIWidget(props: UIWidgetProps): JSX.Element | null {


We should also have a comment explaining UIWidget.

dgodinez-dh · 2026-05-11T15:58:02Z

+import PortalPanel from './layout/PortalPanel';
+import UIWidget from './UIWidget';
+
+export const UIWidgetPlugin: WidgetPlugin<dh.Widget> = {


We should also have a comment explaining UIWidgetPlugin.

dgodinez-dh · 2026-05-11T16:17:25Z

+      // eslint-disable-next-line react/jsx-no-useless-fragment
+      <></>
+    ),
+    // We only want to update this callback when the descriptor changes, not


Why do we update this callback as the return value never changes? I can see that we do it intentionally. Is it to trigger an update in WidgetHandler when the descriptor changes?

Good catch, I re-wired this and it shouldn't need to change on the descriptor anymore.

- Use the content of the panel instead of the full dashboard

github-actions · 2026-05-11T21:51:00Z

ui docs preview (Available for 14 days)

mofojed · 2026-05-11T21:58:25Z

@dsmmcken ui.spec.ts-snapshots: I have it opening the ui_render_all from the embed widget screen, rather than the main app; because dashboards now open as nested dashboards (within a panel in the Code Studio). Because of that, it's a slightly different height (because there's no dashboards listed across the top from the embed widget view).
On the Enterprise side, I think this would be desirable when creating dashboards from a code studio; your console input isn't hidden in another tab then, and you can easily try running edits to your dashboard.
Architectural it's simpler, as we don't need to wait for the component to load and then open a dashboard while closing the panel. (Opening the widget triggers opening a panel, which then loads the plugin and renders the dashboard in that panel - plugin needs to close that panel and open a new dashboard tab, which has hacks for the Code Studio keeping track of them, etc).
Do we still want that behaviour of dashboards created/opened in a Code Studio always open in a new dashboard tab?
On a related note - should dashboards be visible in the Panels menu? With nested dashboards there's no reason user's can't create an ad hoc dashboard with a bunch of other dashboards added to it.

github-actions · 2026-05-12T14:25:55Z

ui docs preview (Available for 14 days)

dgodinez-dh

Changes look good. Looks like there is a failing test though.

- These weren't actually an issue the issue I was trying to fix, but the type errors I was getting in CI don't make sense: https://github.com/deephaven/deephaven-plugins/actions/runs/25740228037/job/75588279678?pr=1341 - References REACT_PANEL_VISIBLE not being a valid symbol in ui_table.spec.ts, but that's not used anywhere in that file - Pushing this fix to see if it kicks CI into behaving

github-actions · 2026-05-12T17:29:35Z

ui docs preview (Available for 14 days)

margaretkennedy

Docs LGTM

…ards - So we can still open widgets as dashboards from code studios

github-actions · 2026-05-13T21:14:31Z

ui docs preview (Available for 14 days)

mofojed added 12 commits April 27, 2026 09:40

Update types, remove duplicate types

16c6325

Cleanup after self-review

fd4c6f9

Fix up styling fix up tests

7258fab

fix: update e2e selectors from .dh-react-panel to .dh-panel.widget-lo…

022311d

…ader

package-lock updates

2ed7530

WIP update snapshots

5e71959

- There's an issue here - when the ui.dashboard is the othermost thing, it should just take over the outer dashboard. Right now it's embeddign in. Need to fix that.

Update some more snapshots...

d4f2271

WIP show a loading spinner when loading

def07ab

mofojed self-assigned this Apr 27, 2026

mofojed added 4 commits April 28, 2026 20:46

Fix jest config

5206dd3

fix: provide WidgetStatusContext in DocumentHandler tests

3c12046

Change up how things were named...

8985543

Remove updated snapshots...

1cd9196

- Shouldn't need to update all of these, there are likely some other fixes I need to do.

Get rid of dh-react-panel css on the defaultpanelcontent

5dc2ae0

mofojed mentioned this pull request Apr 29, 2026

feat: DH-21757: WidgetPlugin support in deephaven.ui #1326

Closed

Clean up some scss

0cf90fb

- now we don't have padding on the dashboard in the embed widget app scenario

Clean up some of the test selectors

eca77e8

Update ui loading spec

676c9aa

mofojed marked this pull request as ready for review April 29, 2026 15:36

mofojed requested review from a team and removed request for a team April 29, 2026 15:36

Add docs snapshots

b5987f8

margaretkennedy previously approved these changes May 7, 2026

View reviewed changes

mofojed requested a review from dsmmcken May 8, 2026 13:44

dsmmcken requested changes May 8, 2026

View reviewed changes

Update plugins/ui/docs/components/dashboard.md

94fb997

Co-authored-by: Don <dsmmcken@gmail.com>

mofojed dismissed margaretkennedy’s stale review via 94fb997 May 11, 2026 14:21

mofojed requested a review from dgodinez-dh May 11, 2026 14:21

test: replace ticking time_table with static empty_table in ui_home_s…

c6a28c2

…creen

dgodinez-dh requested changes May 11, 2026

View reviewed changes

Fix up render all snapshots

f2baf18

- Use the content of the panel instead of the full dashboard

Cleanup based on review

4217358

mofojed requested review from dgodinez-dh and dsmmcken May 12, 2026 14:26

dgodinez-dh previously approved these changes May 12, 2026

View reviewed changes

mofojed dismissed dgodinez-dh’s stale review via 209e903 May 12, 2026 17:26

margaretkennedy previously approved these changes May 13, 2026

View reviewed changes

Register as a WidgetDashboard type to allow opening widgets as dashbo…

771f24c

…ards - So we can still open widgets as dashboards from code studios

mofojed dismissed margaretkennedy’s stale review via 771f24c May 13, 2026 21:10

mofojed mentioned this pull request May 13, 2026

feat: DH-21757: Allow widget plugins to register types as dashboard types deephaven/web-client-ui#2679

Open


		type UIWidgetProps = WidgetComponentProps<dh.Widget>;

		export function UIWidget(props: UIWidgetProps): JSX.Element \| null {

Conversation

mofojed commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 27, 2026

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

github-actions Bot commented May 6, 2026

Uh oh!

margaretkennedy left a comment

Choose a reason for hiding this comment

Uh oh!

dsmmcken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dsmmcken May 8, 2026

Choose a reason for hiding this comment

Uh oh!

mofojed commented May 11, 2026

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

mofojed commented May 11, 2026

Uh oh!

dgodinez-dh May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dgodinez-dh May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dgodinez-dh May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dgodinez-dh May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dgodinez-dh May 11, 2026

Choose a reason for hiding this comment

Uh oh!

mofojed May 12, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

mofojed commented May 11, 2026

Uh oh!

github-actions Bot commented May 12, 2026

Uh oh!

dgodinez-dh left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 12, 2026

Uh oh!

margaretkennedy left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mofojed commented Apr 27, 2026 •

edited

Loading